/*
 * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.graal.python.lib;

import com.oracle.graal.python.builtins.PythonBuiltinClassType;
import com.oracle.graal.python.builtins.objects.common.SequenceStorageNodes;
import com.oracle.graal.python.builtins.objects.type.TypeNodes;
import com.oracle.graal.python.nodes.builtins.TupleNodes;
import com.oracle.graal.python.nodes.classes.IsSubtypeNode;
import com.oracle.graal.python.nodes.object.BuiltinClassProfiles;
import com.oracle.graal.python.nodes.object.BuiltinClassProfiles.IsBuiltinObjectProfile;
import com.oracle.graal.python.nodes.object.GetClassNode;
import com.oracle.graal.python.runtime.sequence.storage.SequenceStorage;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.Fallback;
import com.oracle.truffle.api.dsl.GenerateInline;
import com.oracle.truffle.api.dsl.GenerateUncached;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.profiles.InlinedLoopConditionProfile;

/**
 * Equivalent of {@code PyErr_GivenExceptionMatches}. Note that if you just want to match against a
 * single specific exception type, this node is an overkill and you should use
 * {@link IsBuiltinObjectProfile} instead. Only use when you need to handle tuples of types as well.
 */
@GenerateInline(inlineByDefault = true)
@GenerateUncached
public abstract class PyErrExceptionMatchesNode extends Node {
    public abstract boolean execute(Node inliningTarget, Object exception, Object typeOrTuple);

    public static boolean executeUncached(Object exception, Object typeOrTuple) {
        return PyErrExceptionMatchesNodeGen.getUncached().execute(null, exception, typeOrTuple);
    }

    // Truffle complains about the limit, but it's needed for the fallback
    @SuppressWarnings("truffle-unused")
    @Specialization(guards = "isExceptionType(inliningTarget, type, isTypeNode, isBuiltinClassProfile)", limit = "1")
    static boolean doException(@SuppressWarnings("unused") Node inliningTarget, Object exception, Object type,
                    @SuppressWarnings("unused") @Cached BuiltinClassProfiles.IsBuiltinClassProfile isBuiltinClassProfile,
                    @Cached TypeNodes.IsTypeNode isTypeNode,
                    @Cached PyExceptionInstanceCheckNode exceptionCheck,
                    @Cached GetClassNode getClassNode,
                    @Cached(inline = false) IsSubtypeNode isSubtypeNode) {
        if (exceptionCheck.execute(inliningTarget, exception)) {
            return isSubtypeNode.execute(getClassNode.execute(inliningTarget, exception), type);
        } else if (isTypeNode.execute(inliningTarget, exception)) {
            return isSubtypeNode.execute(exception, type);
        } else {
            return false;
        }
    }

    @Specialization(guards = "tupleCheck.execute(inliningTarget, tuple)", limit = "1")
    static boolean doTuple(Node inliningTarget, Object exception, Object tuple,
                    @SuppressWarnings("unused") @Cached PyTupleCheckNode tupleCheck,
                    @Cached TupleNodes.GetTupleStorage getTupleStorage,
                    @Cached SequenceStorageNodes.GetItemScalarNode getItemScalarNode,
                    @Cached InlinedLoopConditionProfile loopConditionProfile,
                    @Cached(inline = false) PyErrExceptionMatchesNode recursive) {
        SequenceStorage storage = getTupleStorage.execute(inliningTarget, tuple);
        int len = storage.length();
        loopConditionProfile.profileCounted(inliningTarget, len);
        for (int i = 0; loopConditionProfile.inject(inliningTarget, i < len); i++) {
            if (recursive.execute(null, exception, getItemScalarNode.execute(inliningTarget, storage, i))) {
                return true;
            }
        }
        return false;
    }

    @Fallback
    @SuppressWarnings("unused")
    static boolean fallback(Object exception, Object invalid) {
        return false;
    }

    protected static boolean isExceptionType(Node inliningTarget, Object type, TypeNodes.IsTypeNode isTypeNode, BuiltinClassProfiles.IsBuiltinClassProfile isBuiltinClassProfile) {
        return isTypeNode.execute(inliningTarget, type) && isBuiltinClassProfile.profileClass(inliningTarget, type, PythonBuiltinClassType.PBaseException);
    }
}
